home *** CD-ROM | disk | FTP | other *** search
/ Canadian Geographic Explorer / Canadian Geographic Explorer.iso / pc / comp.z / HELPER.HLP < prev    next >
Encoding:
Text File  |  1996-05-01  |  5.6 KB  |  149 lines
  1. @title{Helper}{Help Panel}
  2.  
  3.  The Help panel performs functions for navigating through help
  4.  text contained in help files (*.HLP) and EASI procedures (*.EAS).
  5.  
  6.  The panel is composed of a main area which contains the actual text
  7.  extracted from the help file or EASI procedure. A smaller area under
  8.  the text block titled "Subtopics / See Also" contains a list of
  9.  other topics associated with the text currently displayed in the main
  10.  area.
  11.  
  12.  There is an option menu above the "Subtopics / See Also" list which 
  13.  determines the sort order of the list. A sort order of "None" means
  14.  that the subtopics are listed first (in the order they appear in the
  15.  help file) followed by the See Alsos. A sort order of "Alphabetical"
  16.  means that the subtopics and see also topics are sorted together
  17.  in alphabetical order.
  18.  
  19.  The See Also topics can be distinguished in the list by the presence
  20.  of "..." following the topic name.
  21.  
  22.  There are several buttons under the "Subtopics / See Also" list
  23.  which facilitate the traversal of help topics. 
  24.  
  25.  The "Next" button displays the text for the next subtopic from 
  26.  the current topic. It can be used to read the subtopics of a particular
  27.  topic in order. 
  28.  
  29.  The help topics are organized into a tree where each topic is a node and 
  30.  its children are subtopics. Essentially, this button performs a depth 
  31.  first traversal of that tree. Note that this ordering is not necessarily
  32.  the same as the listing in the "Subtopics / See Also". Those are 
  33.  an alphabetical merger of the See Also topics and subtopics. Therefore,
  34.  very rarely will the "Next" button show the topics in the order they
  35.  appear in the list box.
  36.  
  37.  The "Top" button displays the text for the highest level in the
  38.  hierarchy in the current file.
  39.  
  40.  The "Parent" button displays the text for the item of which the
  41.  current text is a subtopic.
  42.  
  43.  The "Search" button activates a panel which allows topic or keyword
  44.  searching. 
  45.  
  46.  The "History" button activates a panel which displays a list of the most
  47.  recently selected help topics.
  48.  
  49.  The "Save" button allows the currently displayed help text to be saved
  50.  into an ASCII text file.
  51.  
  52.  The "Snapshot" button activates a panel containing the text from
  53.  the main area of the Help panel.  The contents of this panel do
  54.  not change and several can be visible at once with different contents.
  55.  
  56. 1    Functions
  57.  
  58.  The following topics outline some of the functions available from the
  59.  help panel.
  60.  
  61. 2    Search
  62.  
  63.  The search panel is used to find topics that contain a keyword or to
  64.  search on a help topic. The string entered in the text field can either 
  65.  be a simple keyword (i.e. airphoto) or a fully formed help topic string
  66.  (i.e. Xpace|Digitizing). The search
  67.  is activated by pressing enter in the "Keyword or Topic" textfield.
  68.  The list of matching topics is shown in the list below the textfield.
  69.  If the list is empty, this means that no matching topics were found.
  70.  The help for that topic can be displayed by selecting that topic from
  71.  the list. Pressing "Close" pops down the search panel.
  72.  
  73.  Note that the keywords and topics are case insensitive.
  74.  
  75.  See Also: {..|..|Concepts|}Topic Strings, KEYWORDS
  76.  
  77. 2    History
  78.  
  79.  Each time a new help topic is displayed in the main panel, the topic
  80.  is added to a history list. This topic history list can be viewed
  81.  in the history panel which is activated by pressing "History" from
  82.  the main panel. The help for a topic can be redisplayed by selecting 
  83.  it from the list. Pressing "Close" pops down the history panel.
  84.  
  85. 1    Concepts
  86.  
  87.  The following topics outline some of the concepts associated with PCI's
  88.  help system.
  89.  
  90. 2    Help Text Structure
  91.  
  92.  The help text in help files and EASI procedures is organized in
  93.  a hierarchy.  For example, the help text for IVI is structured as
  94.  follows:
  95.  
  96. @verbatim
  97.                                   IVI
  98.                                    |
  99.                   +----------------+----------------+
  100.                   |                |                |
  101.               PARAMETERS        DETAILS          EXAMPLE
  102.                   |
  103.           +-------+-------+-------+-------+
  104.           |       |       |       |       |
  105.         FILE     DBIC    VDOC    DBIW    VDOW
  106. @end
  107.  
  108.  Understanding this structure is important for forming topic strings
  109.  effectively.
  110.  
  111.  See Also: {..|..|Concepts|}Topic Strings
  112.  
  113. 2    Topic Strings
  114.  
  115.  The format of a topic string is:
  116.  
  117.   <topic>|<subtopic-1>|<subtopic-2>| ... |<subtopic-n>
  118.  
  119.  where <topic> is the name of a PACE task or EASI procedure (e.g. IVI
  120.  or PROGNO) and each <subtopic-m> is the name of a subtopic at the
  121.  m'th level in the help hierarchy. 
  122.  
  123.  For example, the search string "IVI|PARAMETERS|FILE" would specify
  124.  the help text explaining the use of the FILE parameter for the PACE
  125.  task IVI.  Note that subtopics in the string do not have
  126.  to be specified completely so for the previous example, "IVI|PAR|FI"
  127.  would achieve the same result.
  128.  
  129.  See Also: {..|}Help Text Structure
  130.  
  131. 1    Helper
  132.  
  133.  The "helper" is a standalone program which activates a help panel
  134.  from the system command prompt rather than from within a PCI application 
  135.  such as ImageWorks. The syntax for the helper command is:
  136.  
  137.   % helper <topic> <subtopic-1> <subtopic-2> ... <subtopic-n>
  138.  
  139.  where <topic> and <subtopic-m> have the same meaning as they do
  140.  in topic strings. 
  141.  
  142.  For example, the following command would display information on the 
  143.  Albers Conical Equal Area projection:
  144.  
  145.   % helper proset proj acea
  146.  
  147.  The helper can also be invoked with no arguments, in which case the
  148.  user can perform a search for an appropriate help topic.
  149.